Skip to main content

Metadata Fields in Requests

This document provides detailed information about the ip and bfphash metadata fields, their purpose, and usage within your application workflows.

1. IP Metadata Field​

IP Description​

The ip field captures the IP address of the requester. It provides information about the origin of the request, enabling functionalities such as geolocation, security checks, and auditing.

IP Usage Scenarios​

  • Geolocation: Identify the geographical location of the requester.
  • Security: Validate and log IP addresses to detect unusual patterns or potential malicious activities.
  • Auditing: Maintain a record of where requests originate for compliance and monitoring.
  • Mobile SDK Matching: Used in conjunction with the mobile SDK.
  • Network Protection: Helps protect against various network attacks by identifying and validating request origins.

IP Example​

{
  "metadata": {
    "ip": "192.168.1.1"
  }
}

In this example, the IP address 192.168.1.1 represents the origin of the request.

2. BFPHash Metadata Field​

BFPHash Description​

The bfphash field is a hashed value that can represent a unique identifier or token associated with the request. It is used to ensure security, integrity, and traceability in workflows.

BFPHash Usage Scenarios​

  • Authentication: Validate the authenticity of a request using the hashed value.
  • Data Integrity: Ensure that the request has not been tampered with.
  • Traceability: Link requests to specific entities or events without exposing sensitive data.
  • Mobile SDK Matching: Used to ensure the registered browser and device are aligned by matching their associated hashed values.
  • Network Protection: Helps protect against various network attacks by ensuring secure and traceable requests.

BFPHash Example​

{
  "metadata": {
    "bfphash": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"
  }
}

In this example, the bfphash contains the hashed value a94a8fe5ccb19ba61c4c0873d391e987982fbbd3, representing a secure token or identifier.

Combined Example​

Below is an example of a metadata object containing both ip and bfphash fields:

{
  "metadata": {
    "ip": "192.168.1.1",
    "bfphash": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"
  }
}

Explanation​

  • ip: The IP address 192.168.1.1 indicates the origin of the request.
  • bfphash: The hashed value ensures the request's security and traceability.

Best Practices​

  1. Secure Storage: Store bfphash values securely, as they may link to sensitive information indirectly.
  2. Validation: Always validate IP addresses and hashed values before processing requests.
  3. Anonymization: If privacy is a concern, consider anonymizing IP addresses in logs or data storage.
  4. Mobile IP and Browser Matching: Ensure the IP and bfphash values match between the mobile device and registered browser for secure verification.

Optional Fields​

Both ip and bfphash are optional fields. However, their inclusion is highly recommended to enhance security and protect against various network attacks. By using these fields effectively, you can add an extra layer of validation and traceability to your workflows.

By using the ip and bfphash metadata fields effectively, you can enhance the security, traceability, and functionality of your application workflows while protecting against potential network threats.

X

Graph View